delbin reliability improvements. Add nukerte, nuketrk, nukewpt, and hint_at_and.

diff --git a/delbin.c b/delbin.c
index 76865787fb50499c24b25a1728f6e4f517282e3c..69579e16f1e37b52d5e8913df4a42e4d7a3b4105 100644 (file)
--- a/delbin.c
+++ b/delbin.c
@@ -2,7 +2,7 @@
        DeLorme PN-20/40 USB "DeLBin" protocol
 
     Copyright (C) 2009 Paul Cornett, pc-gpsb at bullseye.com
-    Copyright (C) 2005  Robert Lipe, robertlipe@usa.net
+    Copyright (C) 2005, 2009  Robert Lipe, robertlipe@gpsbabel.org
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -24,6 +24,7 @@
 #include <assert.h>
 
 #define MYNAME "delbin"
+static short_handle mkshort_handle;
 
 /*
 Device documentation:
@@ -96,9 +97,15 @@ static int n_delbin_units;
 
 #define sizeofarray(x) (sizeof(x) / sizeof(x[0]))
 
-static char* opt_getposn;
-static char* opt_logs;
-static char* opt_long_notes;
+static char *opt_getposn = NULL;
+static char *opt_logs = NULL;
+static char *opt_long_notes = NULL;
+static char *opt_nuke_wpt = NULL;
+static char *opt_nuke_trk = NULL;
+static char *opt_nuke_rte = NULL;
+/* If true, Order hint to match Cache Register and Topo 7 */
+static char *opt_hint_at_end = NULL;
+
 
 static arglist_t delbin_args[] = {
        { "get_posn", &opt_getposn, "Return current position as a waypoint",
@@ -107,6 +114,13 @@ static arglist_t delbin_args[] = {
                NULL, ARGTYPE_BOOL, ARG_NOMINMAX },
        { "long_notes", &opt_long_notes, "Use long waypoint notes regardless of PN version",
                NULL, ARGTYPE_BOOL, ARG_NOMINMAX },
+       {"nukewpt", &opt_nuke_wpt, "Delete all waypoints before sending", NULL, ARGTYPE_BOOL,
+               ARG_NOMINMAX },
+       {"nuketrk", &opt_nuke_trk, "Delete all tracks before sending", NULL, ARGTYPE_BOOL,
+               ARG_NOMINMAX },
+       {"nukerte", &opt_nuke_rte, "Delete all waypoints before sending", NULL, ARGTYPE_BOOL,
+               ARG_NOMINMAX },
+       {"hint_at_end", &opt_hint_at_end, "If true, geocache hint at end of text", NULL, ARGTYPE_BOOL, ARG_NOMINMAX },
        ARG_TERMINATOR
 };
 
@@ -129,6 +143,7 @@ static waypoint** wp_array;
 #define MSG_ACK 0xaa00
 #define MSG_BREAK 0xaa02
 #define MSG_BREAK_SIZE 33
+#define MSG_DELETE 0xb005
 #define MSG_NAVIGATION 0xa010
 #define MSG_REQUEST_ROUTES 0xb051
 #define MSG_REQUEST_ROUTES_SIZE 65
@@ -166,6 +181,33 @@ static waypoint** wp_array;
 //-----------------------------------------------------------------------------
 // Message structures
 
+
+// Input Delete Message
+// Message ID: 0xB005
+typedef enum {
+  nuke_type_wpt = 0,
+  nuke_type_trk = 1,
+  nuke_type_rte = 2,
+  // int nuke_map = 3;
+} nuke_type;
+
+typedef enum {
+  nuke_mode_all = 0,
+  nuke_mode_single = 1
+} nuke_mode;
+
+typedef enum {
+  nuke_dest_internal = 0,
+  nuke_dest_sd = 1
+} nuke_dest;
+
+typedef struct {
+       gbuint8 type;
+       gbuint8 mode;
+       gbuint8 location;
+       gbuint8 object_name[];
+} msg_delete_t;
+
 // Output Waypoint Message
 // Message ID: 0xB013
 // Input Waypoint Message
@@ -809,6 +851,7 @@ send_batch(int expect_transfer_complete)
        message_t m;
        const unsigned n = batch_array_i;
        unsigned i;
+       unsigned progress = 0;
 
        message_init(&m);
        if (global_opts.debug_level >= DBGLVL_M)
@@ -817,6 +860,13 @@ send_batch(int expect_transfer_complete)
                unsigned timeout_count = 0;
                time_t time_start = time(NULL);
 
+               // Can't really trigger this off either i or n as we don't
+               // know how the various packets map to actual waypts.
+               if (global_opts.verbose_status &&
+                  (batch_array[i].msg_id == MSG_WAYPOINT_IN)) {
+                       waypt_status_disp(waypoint_n, ++progress);
+               }
+
                message_write(batch_array[i].msg_id, &batch_array[i].msg);
                for (;;) {
                        unsigned id = message_read_1(0, &m);
@@ -1061,6 +1111,7 @@ get_gc_notes(const waypoint* wp, int* symbol, char** notes, unsigned* notes_size
                }
                gbfputc('\n', fd);
        }
+
        gbfprintf(fd, "Cache ID: %s\n", wp->shortname);
        if (gc_sym) {
                gbfprintf(fd, "%s\n", waypoint_symbol(gc_sym));
@@ -1091,7 +1142,7 @@ get_gc_notes(const waypoint* wp, int* symbol, char** notes, unsigned* notes_size
        } else {
                gbfprintf(fd, "/T%u\n", wp->gc_data->terr / 10);
        }
-       if (wp->gc_data->hint) {
+       if (wp->gc_data->hint && !opt_hint_at_end) {
                gbfprintf(fd, "HINT: %s\n", wp->gc_data->hint);
        }
        if (wp->gc_data->desc_short.utfstring || wp->gc_data->desc_long.utfstring) {
@@ -1146,6 +1197,9 @@ get_gc_notes(const waypoint* wp, int* symbol, char** notes, unsigned* notes_size
                        gbfputc('\n', fd);
                }
        }
+       if (wp->gc_data->hint && opt_hint_at_end) {
+               gbfprintf(fd, "\nHINT: %s\n", wp->gc_data->hint);
+       }
        gbfputc(0, fd);
        *notes_size = fd->memlen;
        *notes = xmalloc(*notes_size);
@@ -1190,6 +1244,25 @@ write_waypoint_notes(const char* notes, unsigned size, const char* name)
        } while (size != 0);
 }
 
+static void
+add_nuke(nuke_type nuke_type)
+{
+       message_t m;
+       msg_delete_t* p;
+
+       message_init_size(&m, 63);
+       p = m.data;
+       p->type = nuke_type;
+       p->mode = nuke_mode_all;
+       p->location = nuke_dest_internal;
+       p->object_name[0] = '0';
+
+       add_to_batch(MSG_DELETE, &m);
+       send_batch(TRUE);
+
+       message_free(&m);
+}
+
 static void
 write_waypoint(const waypoint* wp)
 {
@@ -1217,9 +1290,10 @@ write_waypoint(const waypoint* wp)
                get_gc_notes(wp, &symbol, &notes, &notes_size);
                notes_freeable = notes;
                if (wp->description) {
-                       name = wp->description;
+                       name = mkshort(mkshort_handle, wp->description);
                }
        }
+
        if (notes_size > 800) {
                if (use_extended_notes) {
                        extended_notes_size = notes_size;
@@ -1228,6 +1302,7 @@ write_waypoint(const waypoint* wp)
                        notes_size = 800;
                }
        }
+
        name_size = strlen(name) + 1;
        if (name_size > 255) {
                name_size = 255;
@@ -2042,6 +2117,16 @@ delbin_rw_init(const char *fname)
        message_t m;
        char buf[256];
 
+       if (!mkshort_handle)
+               mkshort_handle = mkshort_new_handle();
+       //  Contrary to doc, it looks like there's a limit of 32 bytes
+       // and a null terminator is required, at least in F/W 2.6.210726
+       // on a PN-40.
+       setshort_length(mkshort_handle, 31);
+       setshort_whitespace_ok(mkshort_handle, 1);
+       setshort_badchars(mkshort_handle, "");
+       setshort_mustuniq(mkshort_handle, 1);
+
        delbin_os_ops.init(fname);
 
        // Often the first packet is part of an old message, sometimes it can
@@ -2086,6 +2171,9 @@ delbin_rw_init(const char *fname)
 static void
 delbin_rw_deinit(void)
 {
+       if (mkshort_handle) {
+               mkshort_del_handle(&mkshort_handle);
+       }
        delbin_os_ops.deinit();
 }
 
@@ -2111,12 +2199,15 @@ static void
 delbin_write(void)
 {
        if (doing_wpts) {
+               if (opt_nuke_wpt) add_nuke(nuke_type_wpt);
                write_waypoints();
        }
        if (doing_trks) {
+               if (opt_nuke_trk) add_nuke(nuke_type_wpt);
                write_tracks();
        }
        if (doing_rtes) {
+               if (opt_nuke_rte) add_nuke(nuke_type_wpt);
                write_routes();
        }
 }
@@ -2286,6 +2377,7 @@ delbin_os_ops_t delbin_os_ops = {
 #include <IOKit/IOKitLib.h>
 #include <IOKit/IOCFPlugIn.h>
 #include <IOKit/hid/IOHIDLib.h>
+#include <mach/mach_error.h>
 
 // IOHIDDeviceInterface121::getReport() does not work, it hangs the process
 // in some sort of unkillable state.  So reading is done via a separate thread
@@ -2362,7 +2454,8 @@ mac_os_init(const char* fname)
        (*plugin)->Release(plugin);
        ir = (*device)->open(device, kIOHIDOptionsTypeSeizeDevice);
        if (ir)
-               fatal(MYNAME ": device open failed 0x%x\n", (int)ir);
+               fatal(MYNAME ": device open failed 0x%x - %s\n", (int)ir,
+                       mach_error_string(ir));
        ir = (*device)->createAsyncEventSource(device, &run_loop_source);
        if (ir)
                fatal(MYNAME ": createAsyncEventSource failed 0x%x\n", (int)ir);

diff --git a/xmldoc/formats/options/delbin-hint_at_and.xml b/xmldoc/formats/options/delbin-hint_at_and.xml
new file mode 100644 (file)
index 0000000..8f2adee
--- /dev/null
+++ b/xmldoc/formats/options/delbin-hint_at_and.xml
@@ -0,0 +1,5 @@
+<para>
+  When set to true, this places the "HINT:" entry from a geocacching.com 
+   pocket query at the end of the screen (scroll up for quick access) like
+   Cache Register and Topo7 do instead of at the top as Topo8 does.
+</para>

diff --git a/xmldoc/formats/options/delbin-logs.xml b/xmldoc/formats/options/delbin-logs.xml
index 2b15c83293be93c8737ec143cc2a70cca9ab02a7..7c3c4fd2b2b51f576d1cec12ea848e5f80cec967 100644 (file)
--- a/xmldoc/formats/options/delbin-logs.xml
+++ b/xmldoc/formats/options/delbin-logs.xml
@@ -1,5 +1,5 @@
 <para>
   When set to true, this includes Groundspeak logs from GPX pocket queries 
   when writing to Delorme devices that support the extended features introduced
-  in firmware version 2.5.
+  in firmware version 2.5 for the PN-40 and PN-30 and in 1.6 for the PN-20.
 </para>

diff --git a/xmldoc/formats/options/delbin-long_notes.xml b/xmldoc/formats/options/delbin-long_notes.xml
index 467179da5c49451567c229535dee41008fb6fa39..86852fe758c085e3b915ea580691de6e5a92e427 100644 (file)
--- a/xmldoc/formats/options/delbin-long_notes.xml
+++ b/xmldoc/formats/options/delbin-long_notes.xml
@@ -5,6 +5,6 @@
 </para>
 <para>
   This option will probably go away in time as most units get upgraded to
-  the capabilities of the 2.5 version of the PN-40, but this is here for
-  the PN-20 and PN-30 which are less well known for now.
+  the capabilities of the 2.5 version of the PN-40 and PN-30 or version 1.6 
+  for the PN-20.
 </para>

diff --git a/xmldoc/formats/options/delbin-nukerte.xml b/xmldoc/formats/options/delbin-nukerte.xml
new file mode 100644 (file)
index 0000000..4abaf6f
--- /dev/null
+++ b/xmldoc/formats/options/delbin-nukerte.xml
@@ -0,0 +1,5 @@
+<para>
+  When present on the command line and sending routes with -r, this will erase
+  all routes in the receiver before sending the new ones.
+</para>
+

diff --git a/xmldoc/formats/options/delbin-nuketrk.xml b/xmldoc/formats/options/delbin-nuketrk.xml
new file mode 100644 (file)
index 0000000..29678da
--- /dev/null
+++ b/xmldoc/formats/options/delbin-nuketrk.xml
@@ -0,0 +1,4 @@
+<para>
+  When present on the command line and sending tracks with -t, this will erase
+  all tracks in the receiver before sending the new ones.
+</para>

diff --git a/xmldoc/formats/options/delbin-nukewpt.xml b/xmldoc/formats/options/delbin-nukewpt.xml
new file mode 100644 (file)
index 0000000..9f510a7
--- /dev/null
+++ b/xmldoc/formats/options/delbin-nukewpt.xml
@@ -0,0 +1,5 @@
+<para>
+  When present on the command line and sending waypoins (either explicitly 
+  via -w or as the default), this will erase
+  all waypoints in the receiver before sending the new ones.
+</para>